Aggregate flow over an arbitrary [start, end] window

curl --request GET \
  --url https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "ticker": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "tradeCount": 1,
    "sweepCount": 1,
    "totalPremium": 123,
    "aggregate": {
      "vwf": 123,
      "sdf": 123,
      "fir": 123,
      "composite": 123
    },
    "premiumSplit": {
      "bullishPremium": 123,
      "bearishPremium": 123,
      "neutralPremium": 123,
      "netPremium": 123,
      "bullishCount": 1,
      "bearishCount": 1,
      "neutralCount": 1,
      "sweepPremium": 123
    },
    "interpretation": {},
    "queryTimeMs": 1
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "d7574836"
  }
}

GET

flow

{ticker}

aggregate

Aggregate flow over an arbitrary [start, end] window

curl --request GET \
  --url https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://flow-api.skylit.ai/v1/flow/{ticker}/aggregate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "ticker": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "tradeCount": 1,
    "sweepCount": 1,
    "totalPremium": 123,
    "aggregate": {
      "vwf": 123,
      "sdf": 123,
      "fir": 123,
      "composite": 123
    },
    "premiumSplit": {
      "bullishPremium": 123,
      "bearishPremium": 123,
      "neutralPremium": 123,
      "netPremium": 123,
      "bullishCount": 1,
      "bearishCount": 1,
      "neutralCount": 1,
      "sweepPremium": 123
    },
    "interpretation": {},
    "queryTimeMs": 1
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "d7574836"
  }
}

Authorizations

Authorization

string

header

required

Skylit API key in the Authorization header (Authorization: Bearer fs_live_<key>). X-API-Key is also accepted.

Path Parameters

ticker

string

required

Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Example:

"SPY"

Query Parameters

start_time

string

required

Lower bound of the window. Accepts RFC 3339 (2026-05-27T13:30:00Z) or Unix seconds.

Example:

"2026-05-27T13:30:00Z"

end_time

string

required

Upper bound of the window (RFC 3339 or Unix seconds).

Example:

"2026-05-27T20:00:00Z"

option_type

enum<string>

default:all

Available options:

call,

put,

all

min_premium

number<double>

exclude_multi_leg

boolean

default:false

Exclude trades flagged as part of a multi-leg structure.

min_dte

integer

Required range: x >= 0

max_dte

integer

Required range: x >= 0

date

string<date>

Response

Window-aggregated flow scores.

data

object

required

Show child attributes

Flow

Sector

Market

Sweeps

Analytics

Scoring

Ratios

Underlying

Contract

Dark Pool

Meta

Aggregate flow over an arbitrary [start, end] window

Authorizations

Path Parameters

Query Parameters

Response